Reference Data Format

Depending on the reference data you plan to use, you will need to ensure that your incoming data includes the required parameters.

This tutorial covers the input format for the reference data plugin as well as a few other important considerations regarding your data.

Important: This tutorial does not cover all data formats. Additional formats will be included at a later date.

Data Considerations

Your incoming data must include a date field.
- The key for the date field should be "DT".
- The value of the date field must be a JavaScript Date() object or be a value that can be coerced into a a Date() object (epoch or a ISO 8601 standard string)
Example:
```
{
  "DT": "2025-01-12",
  "Close": 43.97
}
```

Data lists sent into the chart must be in ascending chronological order.

Example:

[
  {
    "DT": "2025-01-29",
    "Open": 43.97,
    "High": 43.97,
    "Low": 43.75,
    "Close": 43.94,
    "Volume": 1003200
  },
  {
    "DT": "2025-01-30",
    "Open": 43.97,
    "High": 44.25,
    "Low": 43.97,
    "Close": 44.25,
    "Volume": 480500
  },
  {
    "DT": "2025-01-31",
    "Open": 44.22,
    "High": 44.38,
    "Low": 44.13,
    "Close": 44.34,
    "Volume": 201300
  }
]

Some datasets require only the date ("DT") and "Close" price, while others, such as the EPS study, require "High" and "Low" properties. Each data format is outlined in the following section.

EPS

EPS combines EPS Guidance Median, EPS Consensus' high and low data, and EPS Surprise markers (if available).

EPS Estimate shows as a series on the main chart, much like a comparison. The default display type for EPS Estimate is a line chart.

Consensus

Important: Your non-S&P EPS reference data must include an "EPS_Median" and "EPS_Consensus" object formatted exactly as shown below, with the exact object names.

{
  "EPS_MEDIAN": {
      "DT": JavaScript Date Object,
      "Close": Number
  },
  "EPS_CONSENSUS": {
      "DT": JavaScript Date Object,
      "High": Number,
      "Low": Number
  }
}

Guidance

{
  "DT": JavaScript Date Object,
  "High": Number,
  "Low": Number
}

Surprise

{
  "DT": JavaScript Date Object,
  "Close": Number
}

Target Price

{
  "DT": JavaScript Date Object,
  "Close": Number
}

EPS Estimates

{
  "DT": JavaScript Date Object,
  "Close": Number
}

Revenue Estimates

{
  "DT": JavaScript Date Object,
  "Close": Number
}

Recommendations

{
  "DT": JavaScript Date Object,
  "Close": Number
}

Key Developments

{
  "data": {
    "company_id": "Company ID",
    "company_name": "Entity Name",
    "key_dev_time": "Time String",
    "source": "Data Source",
    "id": "Unique Record ID",
    "category": "Category Description",
    "headline": "Headline or Summary",
    "key_dev_date": "JavaScript Date Object",
    "story": "Story or Details",
    "timestamp": "JavaScript Date Object"
  },
  "Date": "JavaScript Date Object"
}

Transactions

{
  "identifier": "Identifier",
  "data": {
    "Target/Issuer Name": "Entity Name",
    "Transaction Status": "Status",
    "Announced/Initial Filing Date": "JavaScript Date Object",
    "Announced/Initial Filing Date (Incl. Bids and Letters of Intent)": "JavaScript Date Object",
    "Definitive Agreement Date": "JavaScript Date Object",
    "Closed/Registration Effective Date": "JavaScript Date Object",
    "Deal Resolution": "Resolution description",
    "Buyer/Investor Name(s)": "Buyer/Investor Name(s)",
    "Buyer/Investors Company ID": "Company ID",
    "Transaction Comments": "Comments or notes"
  },
  "rank": "Number"
}

Next Steps

Symbol Lookup